/**
 *    Copyright (C) 2008, 2009  Victor Smirnov <aist11@gmail.com>
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License along
 *    with this program; if not, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 *    See LICENSE.exceptions in the root folder of this project for possible
 *    exceptions
 *
 */

#ifndef _CUBEFS_API_COLLECTIONS_MODEL_HPP
#define	_CUBEFS_API_COLLECTIONS_MODEL_HPP

#include <cubefs/api/models/iterator.hpp>

namespace cubefs    {
namespace api       {

struct Container;

struct CUBEFS_API Model: public Typed {

    struct LockType {enum {READ, WRITE};};

    virtual TypedIDValue* GetRootID()                   		= 0;
    virtual BigInt ModelName()                          = 0;
    virtual BigInt GetRawSize()                         = 0;
    virtual void Drop(Container* container)             = 0;
    virtual bool Check(Typed* data)                     = 0;

    virtual BigInt GetLockCount(Int lock_type)          = 0;
    virtual bool TryLock(Int lock_type)                 = 0;
    virtual BigInt Lock(Int lock_type, BigInt timeout)  = 0;
    virtual bool Unlock(Int lock_type)                  = 0;

    static Type* MyType();
};

CUBEFS_DECLARE_TYPENAME(Model,    "cubefs::api::models::Model");

}
}


#endif
